<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>DepthSense SDK: DepthSense::Interface Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="logo_softkinetic-198x55.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">DepthSense SDK
   
   </div>
   <div id="projectbrief">The DepthSense Software Development Kit</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceDepthSense.html">DepthSense</a>      </li>
      <li class="navelem"><a class="el" href="classDepthSense_1_1Interface.html">Interface</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">DepthSense::Interface Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="DepthSense::Interface" -->
<p>The base interface class.  
 <a href="classDepthSense_1_1Interface.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for DepthSense::Interface:</div>
<div class="dyncontent">
<div class="center"><img src="classDepthSense_1_1Interface__inherit__graph.png" border="0" usemap="#DepthSense_1_1Interface_inherit__map" alt="Inheritance graph"/></div>
<map name="DepthSense_1_1Interface_inherit__map" id="DepthSense_1_1Interface_inherit__map">
<area shape="rect" id="node3" href="classDepthSense_1_1Context.html" title="Represents an application session." alt="" coords="209,5,356,35"/><area shape="rect" id="node5" href="classDepthSense_1_1Device.html" title="Represents a camera device." alt="" coords="212,59,353,88"/><area shape="rect" id="node7" href="classDepthSense_1_1Node.html" title="Represents a stream data source." alt="" coords="216,112,349,141"/><area shape="rect" id="node9" href="classDepthSense_1_1AudioNode.html" title="Represents an audio stream data source." alt="" coords="427,32,592,61"/><area shape="rect" id="node11" href="classDepthSense_1_1ColorNode.html" title="Represents a color stream data source." alt="" coords="428,85,591,115"/><area shape="rect" id="node13" href="classDepthSense_1_1DepthNode.html" title="Represents a depth stream data source." alt="" coords="425,139,593,168"/><area shape="rect" id="node15" href="classDepthSense_1_1UnsupportedNode.html" title="Represents an unsupported stream data source." alt="" coords="407,192,612,221"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classDepthSense_1_1Interface-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDepthSense_1_1Interface_1_1PropertyChangedData.html">PropertyChangedData</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the <a class="el" href="classDepthSense_1_1Interface_1_1PropertyChangedEvent.html" title="Event raised when a property has changed.">DepthSense::Interface::PropertyChangedEvent</a> arguments.  <a href="structDepthSense_1_1Interface_1_1PropertyChangedData.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface_1_1PropertyChangedEvent.html">PropertyChangedEvent</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Event raised when a property has changed.  <a href="classDepthSense_1_1Interface_1_1PropertyChangedEvent.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDepthSense_1_1Context.html">DepthSense::Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a018cff1ebe519dd938d2f5f215c16426">getContext</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the parent context.  <a href="#a018cff1ebe519dd938d2f5f215c16426"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDepthSense_1_1Type.html">DepthSense::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a90e7e833aa0110461d736573010d66f4">getType</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the runtime type of the current instance.  <a href="#a90e7e833aa0110461d736573010d66f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a12a9646f7fee1c7c32cb37793e47a767">isSet</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the current instance is set.  <a href="#a12a9646f7fee1c7c32cb37793e47a767"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDepthSense_1_1Interface_1_1PropertyChangedEvent.html">DepthSense::Interface::PropertyChangedEvent</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a625e7b59c8c0b986ddc5609b578a89b9">propertyChangedEvent</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>propertyChanged</code> event object.  <a href="#a625e7b59c8c0b986ddc5609b578a89b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a9296d7fe17ee8c97ef18badc1111b498">unset</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsets the current instance.  <a href="#a9296d7fe17ee8c97ef18badc1111b498"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classDepthSense_1_1Type.html">DepthSense::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDepthSense_1_1Interface.html#a12f0783f3b1d2f077aae21ecdc0d2ced">type</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">DepthSense::Interface</a> type object.  <a href="#a12f0783f3b1d2f077aae21ecdc0d2ced"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">Interface</a> class is the common base class for all <a class="el" href="namespaceDepthSense.html" title="The DepthSense Software Development Kit.">DepthSense</a> interfaces. It provides facilities for introspecting the runtime type of an object and for setting or unsetting the current instance.</p>
<p>The <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">Interface</a> class and its subclasses feature automatic memory management, implemented with reference counted smart pointer mechanisms. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a018cff1ebe519dd938d2f5f215c16426"></a><!-- doxytag: member="DepthSense::Interface::getContext" ref="a018cff1ebe519dd938d2f5f215c16426" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classDepthSense_1_1Context.html">DepthSense::Context</a> <a class="el" href="classDepthSense_1_1Interface.html#a018cff1ebe519dd938d2f5f215c16426">DepthSense::Interface::getContext</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the context associated with the current interface.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the parent context </dd></dl>

</div>
</div>
<a class="anchor" id="a90e7e833aa0110461d736573010d66f4"></a><!-- doxytag: member="DepthSense::Interface::getType" ref="a90e7e833aa0110461d736573010d66f4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classDepthSense_1_1Type.html">DepthSense::Type</a> <a class="el" href="classDepthSense_1_1Interface.html#a90e7e833aa0110461d736573010d66f4">DepthSense::Interface::getType</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the runtime type of the current instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the runtime type of the current instance</dd></dl>
<dl class="exception"><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::bad_alloc</td><td>not enough memory to perform the requested operation </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a12a9646f7fee1c7c32cb37793e47a767"></a><!-- doxytag: member="DepthSense::Interface::isSet" ref="a12a9646f7fee1c7c32cb37793e47a767" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classDepthSense_1_1Interface.html#a12a9646f7fee1c7c32cb37793e47a767">DepthSense::Interface::isSet</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if the current instance is set.</p>
<p>Given a variable <code>i</code> (of type <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">Interface</a>) and a variable <code>p</code> (of type <code>void*</code>), the <code>i.isSet()</code> expression is semantically equivalent to <code>p != NULL</code>. </p>
<dl class="user"><dt><b>Example:</b></dt><dd><pre>
            <a class="el" href="classDepthSense_1_1AudioNode.html" title="Represents an audio stream data source.">DepthSense::AudioNode</a> audioNode;
            bool b = audioNode.isSet(); // b is false
            </pre></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>whether the current instance is set </dd></dl>

</div>
</div>
<a class="anchor" id="a625e7b59c8c0b986ddc5609b578a89b9"></a><!-- doxytag: member="DepthSense::Interface::propertyChangedEvent" ref="a625e7b59c8c0b986ddc5609b578a89b9" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classDepthSense_1_1Interface_1_1PropertyChangedEvent.html">DepthSense::Interface::PropertyChangedEvent</a>&amp; <a class="el" href="classDepthSense_1_1Interface.html#a625e7b59c8c0b986ddc5609b578a89b9">DepthSense::Interface::propertyChangedEvent</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a reference to the <code>propertyChanged</code> event object, which can be used to connect handlers to that event.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the <code>propertyChanged</code> event object</dd></dl>
<dl class="exception"><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::bad_alloc</td><td>not enough memory to perform the requested operation </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a12f0783f3b1d2f077aae21ecdc0d2ced"></a><!-- doxytag: member="DepthSense::Interface::type" ref="a12f0783f3b1d2f077aae21ecdc0d2ced" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classDepthSense_1_1Type.html">DepthSense::Type</a> <a class="el" href="classDepthSense_1_1Interface.html#a12f0783f3b1d2f077aae21ecdc0d2ced">DepthSense::Interface::type</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">DepthSense::Interface</a> type object</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">DepthSense::Interface</a> type object</dd></dl>
<dl class="exception"><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::bad_alloc</td><td>not enough memory to perform the requested operation </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="classDepthSense_1_1Context.html#a55155ee097d775eb03020b99f64feab6">DepthSense::Context</a>, <a class="el" href="classDepthSense_1_1Device.html#afec0c2f2a13a6f19f986459a58acd613">DepthSense::Device</a>, <a class="el" href="classDepthSense_1_1UnsupportedNode.html#a88883738f01359100494140965949c83">DepthSense::UnsupportedNode</a>, <a class="el" href="classDepthSense_1_1DepthNode.html#a30e250f5ed1fd762b6074561dfd47986">DepthSense::DepthNode</a>, <a class="el" href="classDepthSense_1_1ColorNode.html#a6ec20922395eef57526d7fdab833ea8a">DepthSense::ColorNode</a>, <a class="el" href="classDepthSense_1_1AudioNode.html#a42674e643d70e49aa0404deef4939e6e">DepthSense::AudioNode</a>, and <a class="el" href="classDepthSense_1_1Node.html#a208dbe923824e57bdb4e2181494290ba">DepthSense::Node</a>.</p>

</div>
</div>
<a class="anchor" id="a9296d7fe17ee8c97ef18badc1111b498"></a><!-- doxytag: member="DepthSense::Interface::unset" ref="a9296d7fe17ee8c97ef18badc1111b498" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classDepthSense_1_1Interface.html#a9296d7fe17ee8c97ef18badc1111b498">DepthSense::Interface::unset</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Unsets the current instance.</p>
<p>Given a variable <code>i</code> (of type <a class="el" href="classDepthSense_1_1Interface.html" title="The base interface class.">Interface</a>) and a variable <code>p</code> (of type <code>void*</code>), the <code>i.unset();</code> statement is semantically equivalent to <code>p = NULL;</code>. </p>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 10 2015 22:37:23 for DepthSense SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
